<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/struc/shm/serializer.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_330ec51ed7bfaf381355aaef7c1667ec.html">transport</a></li><li class="navelem"><a class="el" href="dir_6bf669985e0a4bfed5b74de88b3e7893.html">struc</a></li><li class="navelem"><a class="el" href="dir_ad52dd8cdf71953d2954f95ecd6c0394.html">shm</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">serializer.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Shared Memory</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="heap__serializer_8hpp.html">ipc/transport/struc/heap_serializer.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2error_8hpp.html">ipc/transport/struc/shm/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="capnp__msg__builder_8hpp.html">ipc/transport/struc/shm/capnp_msg_builder.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;flow/error/error.hpp&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;boost/move/make_unique.hpp&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport_1_1struc_1_1shm.html">ipc::transport::struc::shm</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"></span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">/// shm::Builder base that contains non-parameterized `public` items such as tag types and constants.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html">   33</a></span><span class="comment"></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html">Builder_base</a></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"></span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">   * A message of this size will be able to completely contain the (single) segment emitted by</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment">   * Builder::emit_serialization() no matter how large or complex the user data loaded into</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment">   * Builder::payload_msg_builder().  This value is safely large enough yet also is tight (small) enough</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">   * to avoid waisting RAM or cycles when allocating messages that would store these segments.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment">   *</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">   * This number should be enough to definitely fit any transported blob returned by any</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment">   * `Shm_session::lend_object()` regardless of the concrete type of `Shm_session`.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment">   */</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html#a2dae5df49d355c6f2199af42fff9befd">   48</a></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html#a2dae5df49d355c6f2199af42fff9befd">S_MAX_SERIALIZATION_SEGMENT_SZ</a> = 512;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>};</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"></span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">/**</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-controlled</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * message using the SHM provider of choice, in SHM, and (2) straightforwardly allocating 1 segment in regular heap</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * and placing the SHM handle there for transmission over IPC.  That is, each mutation via payload_msg_builder()</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * may, as needed, trigger a SHM allocation.  In this algorithm, unlike Heap_fixed_builder, the size of</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * each (SHM-)allocated segment will be determined intelligently based on an exponential-growth algorithm,</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * similarly to that mode of capnp&#39;s `MallocMessageBuilder`.  Hence there is no knob to control segment size, as</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * it is determined dynamically, internally.</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> *</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * ### Failure mode; reasonable uses ###</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * First see &quot;Failure mode&quot; and &quot;Reasonable uses&quot; in Heap_fixed_builder doc header;</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * then come back here.  Back already?  Good news:</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * that failure mode (leaf-too-big) does *not* apply here.  As long as the SHM provider is able to dole out RAM,</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * there is no limit at all on the size/complexity of what one mutates over payload_msg_builder().  In fact `*this`</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * provides the &quot;2-layer approach&quot; specified in that doc header section you just came back from reading.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> *</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * There are two realistic failure modes in `*this`.  The first is the following:</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> *   -# User attempts to mutate via payload_msg_builder().</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *   -# capnp internals recognize the current segment is used up and asks for a new segment of at least N bytes.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *   -# `*this` asks the SHM provider (see template param docs below) to allocate &gt;=N bytes.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *   -# The SHM provider determines it has run out of space according to its policies/algorithm/limitations and</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> *      throws exception, in spirit similar to `std::bad_alloc`.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *   -# This propagates to the user via their payload_msg_builder() mutation statement: it throws.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> *</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * The key here: This cannot be detected via `*this`.  In spirit it is similar to `Heap_fixed_builder`-originated</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * mutations by the user running out of regular-heap (even virtual disk heap, if enabled) and is outside our scope</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * to control.  The only remedy: choose a SHM provider that does not run out of space beyond simply running out of</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * RAM; e.g., by mapping more SHM pools, or whatever.  Otherwise, all the user can do is catch the `bad_alloc`-like</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * exception around their mutations on payload_msg_builder() and take whatever contingency steps.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> *</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * The second failure mode is emit_serialization() failing.  See its doc header for more information.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * In a similar key, Reader::deserialization() can fail down the line.  See its doc header for more information.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * @see shm::Reader</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> *      Counterpart Struct_reader implementation that can deserialize data that this has serialized.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * @see Struct_builder: implemented concept.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> *</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * @tparam Shm_arena</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *         SHM provider type with the ability to allocate STL-compliant data structures directly in SHM, returning</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *         a `shared_ptr` outer-SHM-handle that is possible to `lend_object()`/`borrow_object()` via</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> *         shm::Builder::Session.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> *         `Shm_arena::Handle&lt;T&gt;` must equal `shared_ptr&lt;T&gt;` (meaning type with standard `shared_ptr&lt;T&gt;` semantics;</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> *         in practice probably either `std::shared_ptr&lt;T&gt;` or `boost::shared_ptr&lt;T&gt;`).</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *         It must provide a `construct&lt;T&gt;()` method as exemplified by shm::classic::Pool_arena::construct().</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> *         (This is an *example*; you do not have to use `Pool_arena` and indeed should choose a SHM provider</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *         suitable to your needs, especially as regards to being able to allocate sufficiently large segments.)</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *         That is: `Handle&lt;T&gt; construct&lt;T&gt;(...ctor_args...)`, such that if it returned `p` then</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *         `session::shm::Arena_to_shm_session_t&lt;Shm_arena&gt;` pointee has method</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> *         `flow::util::Blob_sans_log_context lend_object&lt;T&gt;(const Handle&lt;T&gt;&amp; p)`.  Next, if the returned blob `b`</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> *         is bit-wise copied into an IPC transport and copied out of it and then given to</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> *         counterpart shm::Reader, then `shm::Reader::Session` pointee has method `borrow_object&lt;T&gt;(b)` that shall</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *         return (in the receiving process) `Handle&lt;T&gt;` that points to the same SHM-stored data structure originally</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *         returned by `construct()`.  In addition `Shm_arena` must be compatible with `Stateless_allocator`</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *         requirements as explained in &quot;Additional formal requirements&quot; below.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *         Lastly, `lend_object()` and `borrow_object()` may return an empty blob/null respectively, indicating</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *         (assuming proper inputs) the session is permanently down (opposing process is likely down/closed session).</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * ### Additional formal requirements w/r/t `Shm_arena` ###</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * Information on `T` that `*this` shall use with `Shm_arena::construct&lt;T&gt;()`: As of this writing it is</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * `list&lt;Basic_blob&gt;`, representing (internally) the capnp-requested 1+ segments in which the serialization</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * mutated via payload_msg_builder() is stored in zero-copy fashion.  In order for this to work, the `Allocator`</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * template arg on both `list` and the inner `Blob`s shall be ipc::shm::stl::Stateless_allocator.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * Therefore, the requirement is: `Shm_arena` must formally meet the requirements for `Arena` from</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * ipc::shm::stl::Stateless_allocator doc header.  Briefly these are: `allocate(n) -&gt; void*`,</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * `deallocate(void*)`, `Pointer` fancy-pointer type that is SHM-storable.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> *</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * A simple (likely the simplest) example is ipc::shm::classic::Pool_arena, which satisfies both</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> * `Shm_arena` and `session::shm::Arena_to_shm_session_t&lt;Shm_arena&gt;`-pointee requirements.  However, it has deficiencies</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * w/r/t max pool size having to be specified and a non-industry-strength allocation algorithm.  The Jemalloc-based SHM</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * provider in ipc::shm::arena_lend::jemalloc is more complex -- with a separate</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * `Arena_to_shm_session_t&lt;Shm_arena&gt;` pointee from `Shm_arena` -- but lacks these problems.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> */</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Shm_arena&gt;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">  124</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a> :</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>  <span class="keyword">public</span> flow::log::Log_context,</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>  <span class="keyword">public</span> <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html">Builder_base</a></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>{</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"></span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">  /// Short-hand for `Shm_arena` template param.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9bc898884381eebdb03f0dd9f74895de">  132</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9bc898884381eebdb03f0dd9f74895de">Arena</a> = Shm_arena;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"></span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">   * Implements Struct_builder::Config sub-concept.  In this impl: The data members control Builder&#39;s</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">   * behavior as follows:</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">   *</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">   * Builder ctor configured by Config creates builder that shall SHM-allocate segments of internally determined</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">   * sizes subsequently.  The SHM provider is to be supplied to this ctor via #m_arena arg;</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">   * see class doc header for requirements and background.  (The simplest available setup would</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">   * let #Arena = ipc::shm::classic::Pool_arena; with #m_arena = some pre-opened `Pool_arena`.)</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment">   *</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">   * This builder, like all builders in this context, produces a non-zero copy *top serialization*, in this</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   * case storing just a small handful of bits encoding the SHM handle to the true serialization which is SHM-stored.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   * Builder::emit_serialization() will emit to you a top serialization to transmit to the recipient process over</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">   * pipe-like IPC.  This top serialization shall consist of 1 segment, and that segment shall be quite small -- small</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">   * enough to fit into any reasonable Blob_sender message.  *If* framing is required -- in the exact same sense</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment">   * as Heap_fixed_builder::Config::m_frame_prefix_sz and `m_frame_postfix_sz` -- you</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">   * may set either or both of those members to the appropriate non-zero values.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">   */</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html">  151</a></span>  <span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html">Config</a></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>  {</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>    <span class="comment">// Types.</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"></span> </div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">    /// Implements concept API.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ac660f2e20310d2804f3dbcf8e9d1244d">  156</a></span><span class="comment"></span>    <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a> = <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">shm::Builder&lt;Shm_arena&gt;</a>;</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>    <span class="comment">/* ^-- @todo Ideally chg to ...&lt;Arena&gt;, but Doxygen 1.9.3 (at least) then gets somewhat confused and generates</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">     * both Builder&lt;Arena&gt; and Shm_builder&lt;Arena&gt; images in some inheritance diagrams... though clicking on them</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">     * does just go to the proper place either way.  Anyway change it back once the, e.g., Builder_base</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">     * collaboration diagram no longer has that weirdness as a result. */</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span> </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>    <span class="comment">// Data.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"></span> </div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">    /// Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#a4c287783d239663193a681aad8690dd4">  165</a></span><span class="comment"></span>    flow::log::Logger* <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#a4c287783d239663193a681aad8690dd4">m_logger_ptr</a>;</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"></span> </div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">    /// See `struct` doc header.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ab850e04c8a411941c75b74e7c6eccb36">  168</a></span><span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ab850e04c8a411941c75b74e7c6eccb36">m_top_builder_frame_prefix_sz</a>;</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"></span> </div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment">    /// See `struct` doc header.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ae30cd8f4721bccd20ef5f195c332a960">  171</a></span><span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ae30cd8f4721bccd20ef5f195c332a960">m_top_builder_frame_postfix_sz</a>;</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"></span> </div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">    /// See `struct` doc header.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#aca2f1b980653da86d533243f174107f3">  174</a></span><span class="comment"></span>    <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9bc898884381eebdb03f0dd9f74895de">Arena</a>* <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#aca2f1b980653da86d533243f174107f3">m_arena</a>;</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>  }; <span class="comment">// class Config</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"></span> </div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment">   * Implements concept API.  This being a zero-copy (SHM-based) Struct_builder, information is needed for</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment">   * emit_serialization() beyond the payload itself: pointer to a `Shm_session` object.</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment">   */</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d">  181</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d">Session</a> = <a class="code hl_typedef" href="namespaceipc_1_1session_1_1shm.html#af2acc444cc9664e57df8143b66b78d70">session::shm::Arena_to_shm_session_t&lt;Arena&gt;</a>*;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span> </div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"></span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">   */</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9374ce7f0dc46bb841d9359df5d4045f">  189</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9374ce7f0dc46bb841d9359df5d4045f">Builder</a>();</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"></span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">   * Implements concept API.  See Config doc header for information on how `*this` behavior is controlled by `config`.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   *</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment">   * @param config</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"></span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment">   */</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9374ce7f0dc46bb841d9359df5d4045f">Builder</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html">Config</a>&amp; config);</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"></span> </div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment">  /// Disallow copy construction.</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a785a61db43b5f6ee486863eb0f0a56c4">  202</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a785a61db43b5f6ee486863eb0f0a56c4">Builder</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"></span> </div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   *</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   *</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   */</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#ac5d54e207503b67b6d2d75c5eb44e76d">  212</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#ac5d54e207503b67b6d2d75c5eb44e76d">Builder</a>(<a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&amp;&amp; src);</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"></span> </div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment">   * Implements concept API.  In this impl:</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment">   *   - frees the top-serialization 1 segment containing the SHM handle;</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment">   *   - unregisters this process as an owner of the bottom-serialization (the bulky serialization of 1+ segments</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">   *     in SHM).  These bulky SHM-stored segments, therefore, will either be deallocated right now</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">   *     (either because emit_serialization() was not called; or it was, and the counterpart</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">   *     Reader::deserialization() *and dtor* ran before us) or not (if emit_serialization() was called,</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">   *     but either the counterpart shm::Reader::deserialization() or dtor has not yet executed).</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   *     In other words it&#39;s a ref-count (of owner processes) with a max value of 2; and this dtor decrements it</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   *     by 1.</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   *</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   * If emit_serialization() is used more than once (and hence deserialized more than once), then the ref-count</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   * can grow further beyond 2.</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   *</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   * @see Struct_builder::~Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   */</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#af2d88517cf0d99186a6062279d6eb0d3">~Builder</a>();</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment"></span> </div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">  /// Disallow copy assignment.</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2156d8a6653b0f4a43bb8eaf4806536a">  235</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2156d8a6653b0f4a43bb8eaf4806536a">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment"></span> </div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   *</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   *</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   */</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a1f6e7a9e4b810d1737fdb24240e227c1">  246</a></span>  <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a1f6e7a9e4b810d1737fdb24240e227c1">operator=</a>(<a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&amp;&amp; src);</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment"></span> </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   * Implements concept API.  Please see &quot;Failure mode&quot; discussion in our class doc header which notes that</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   * any mutation of what payload_msg_builder() returns may throw a bad-alloc exception, if the SHM provider cannot</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   * satisfy a capnp-required segment-allocation request.</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   *</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   *</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   * @see Struct_builder::payload_msg_builder(): implemented concept.</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   */</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span>  <a class="code hl_class" href="classCapnp__msg__builder__interface.html">Capnp_msg_builder_interface</a>* <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#aaeceaccf183170b1785aa240921ae893">payload_msg_builder</a>();</div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment"></span> </div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   *</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   * ### Errors ###</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">   * error::Code::S_SERIALIZE_FAILED_SESSION_HOSED is eminently possible with at least some providers</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">   * (as of this writing not SHM-classic, yes SHM-jemalloc).  Be ready for this eventuality.</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   *</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   * See also &quot;Failure mode&quot; notes in payload_msg_builder() doc</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * header.  These would manifest before one would have a chance to emit_serialization() though.</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   *</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   * @param target_blobs</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   *        See above.  Also recall (see ctor) that for each returned `blob` (realistically just one):</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   *        individual segment sizes shall never exceed</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment">   *        Config::m_segment_sz (for the [`begin()`, `end()`) area), with `start() == Config::m_frame_prefix_sz`, and</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment">   *        with `capacity() - start() - size() &gt;= Config::m_frame_postfix_sz`.  Config::m_segment_sz is</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">   *        ceiling-nearest-word-adjusted.</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   * @param session</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   *        See above.  In this case... just... see #Session.</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   *        See above.  #Error_code generated: error::Code::S_SERIALIZE_FAILED_SESSION_HOSED (the SHM-session was</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   *        unable to encode the location of the serialization in SHM, for the benefit of the opposing process that</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   *        would deserialize this, because session&#39;s `lend_object()` method indicated</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   *        the session is down).</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   *</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   * @see Struct_builder::emit_serialization(): implemented concept.</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   */</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a7909a2d1e1d24037fb8af5338fffa783">emit_serialization</a>(<a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#a82a69eaa39cbe8a002de1266f1cbb5cb">Segment_ptrs</a>* target_blobs, <span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d">Session</a>&amp; session, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment"></span> </div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   * Implements concept API.  Additionally: this *always* returns 1.  You may rely on this.</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   *</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   *</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   * @see Struct_builder::n_serialization_segments(): implemented concept.</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   */</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a8f01bec0e66080850379df98a2ecf99e">n_serialization_segments</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span> </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment"></span> </div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * The work-horse capnp-aware engine in charge of allocating segments in SHM on capnp&#39;s request,</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   * while user mutates via payload_msg_builder().  This is the bottom-serialization builder.</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   *</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * As explained at the top of the class doc header, this one uses a segment-sizing strategy similar</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   * that of `capnp::MallocMessageBuilder` operating in `GROW_HEURISTICALLY` mode.  I.e., it&#39;ll start with</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   * a reasonable guess for segment 1 size; then grow exponentially each time a new segment is requested.</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   * More or less, each new segment&#39;s size equals that of the preceding segments&#39; sizes added up.</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">   */</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a1609cbc67e5799de53b6ed6671462b74">  308</a></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder.html">Capnp_heap_engine</a> = <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder.html">Capnp_message_builder&lt;Arena&gt;</a>;</div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span> </div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment"></span> </div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">  /// The top-serialization builder, namely Heap_fixed_builder, of our simple SHM-handle-bearing schema.</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a3283aa7dc43b3851b94ff65f1f01d5e1">  313</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a3283aa7dc43b3851b94ff65f1f01d5e1">m_top_engine</a>;</div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment"></span> </div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   * See #Capnp_heap_engine.</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   *</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   * ### Why the `unique_ptr` wrapper? ###</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   * See similar section in Heap_fixed_builder::m_engine doc header.  Same thing here.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   *</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   * Moreover: We also have #m_top_engine, itself a Heap_fixed_builder, which is cheaply move-ctible/assignable</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   * (as of this writing another `unique_ptr` and a `size_t`).  So a move-from for us means</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   * copying those items, plus the wrapping `unique_ptr&lt;Capnp_heap_engine&gt;` here.  That is acceptable perf.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   * Had we not wrapped the 2 #Capnp_msg_builder_interface objects involved (this guy and the one inside</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   * #m_top_engine), a move-from would lug-around something like 400+ bytes; not great.  A couple added</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   * allocs/deallocs of ~8 bytes should indeed be better.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   */</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a828d2e04ba4f62e30ae14518dd33dd63">  328</a></span>  boost::movelib::unique_ptr&lt;Capnp_heap_engine&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a828d2e04ba4f62e30ae14518dd33dd63">m_btm_engine</a>;</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span>}; <span class="comment">// class Builder</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment"></span> </div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">/**</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment"> * Implements Struct_reader concept by interpreting a serialization by shm::Builder with the</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment"> * same template params.  If one understands how to use shm::Builder (see its doc header in-depth),</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment"> * it should be straightforward to figure out how to create/use a `*this`.  Please read that; then come</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment"> * back here.</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment"> *</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment"> * ### How `Shm_arena` is used by a `*this` ###</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment"> * It is a good question, as shm::Reader is conceptually read-only w/r/t the SHM-stored serialization</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment"> * accessed by payload_msg_builder().  So why does it need any #Arena?  Answer: well, it does not need *an* #Arena;</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment"> * unlike with shm::Builder you don&#39;t need to pass-in any `Arena*` into the ctor or elsewhere.  That makes sense:</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment"> * it never allocates anything in SHM, only reads it.  It does however need an equal #Arena template param.</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment"> * Why?  Answer: There are internal reasons having to do with STL-compliant internal storage by the counterpart</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment"> * shm::Builder; to decode its data structures properly it needs to have some type information at compile-time;</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment"> * this &quot;supplies&quot; code -- not data.</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment"> *</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment"> * Anyway, just supply an equal #Arena template param.  Should be fine.</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment"> *</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment"> * ### How shm::Reader::Session (a/k/a `Shm_session`) is used by a `*this` ###</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment"> * shm::Builder, internally, performs `Shm_arena::construct&lt;T&gt;()` to allocate a STL-compliant data structure</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment"> * and yield a `Shm_session`-lendable outer SHM handle.  It performs `Shm_session::lend_object&lt;T&gt;()` in</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment"> * shm::Builder::emit_serialization(), registering the recipient-to-be process as the 2nd owner process.</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment"> * Then the counterpart `*this` performs `Shm_session::borrow_object&lt;T&gt;()` to recover the equivalent</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment"> * outer SHM handle to the same STL-compliant data structure the user had built up via</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment"> * shm::Builder::payload_msg_builder().</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment"> *</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment"> * @see shm::Builder</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment"> *      The counterpart Struct_builder implementation that can create compatible serializations.</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment"> * @see Struct_reader: implemented concept.</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment"> *</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment"> * @tparam Shm_arena</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment"> *         Must be the same as the serializing Builder counterpart.  Note that no object of this type</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment"> *         is required to the ctor unlike with Builder.  Only the type is necessary (see discussion above).</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment"> */</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Shm_arena&gt;</div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">  365</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">Reader</a> :</div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span>  <span class="keyword">public</span> flow::log::Log_context,</div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span>{</div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment"></span> </div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">  /// Short-hand for `Shm_arena` template param.</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3">  373</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3">Arena</a> = Shm_arena;</div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment"></span> </div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">  /// See shm::Builder::Session.</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">  376</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">Session</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d">Builder&lt;Shm_arena&gt;::Session</a>;</div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span>  <span class="comment">// ^-- @todo Ideally chg to ...&lt;Arena&gt;, but... &lt;snip&gt; (see similar @todo above).</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment"></span> </div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">  /// Implements Struct_reader::Config sub-concept.</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">  380</a></span><span class="comment"></span>  <span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">Config</a></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span>  {</div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span>    <span class="comment">// Types.</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment"></span> </div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">    /// Implements concept API.</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#a0fd6d8b923d8748d7c956f6bf6bd7a75">  385</a></span><span class="comment"></span>    <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">Reader</a> = <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">shm::Reader&lt;Shm_arena&gt;</a>;</div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span>    <span class="comment">// ^-- @todo Ideally chg to ...&lt;Arena&gt;, but... &lt;snip&gt; (see similar @todo above).</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span> </div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span>    <span class="comment">// Data.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment"></span> </div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">    /// Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#ad6bac9489c95df6c13a36d467ac1f6aa">  391</a></span><span class="comment"></span>    flow::log::Logger* <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#ad6bac9489c95df6c13a36d467ac1f6aa">m_logger_ptr</a>;</div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment"></span> </div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">     * See shm::Reader class doc header for `Shm_session` discussion.  Must be available until shm::Reader</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">     * dtor runs.  To summarize: shm::Reader shall call `m_session-&gt;borrow_object&lt;T&gt;()` in `deserialization()`.</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">     */</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#a3636cf0176e444342f4e178fbec94fa0">  397</a></span>    <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">Session</a> <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#a3636cf0176e444342f4e178fbec94fa0">m_session</a>;</div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span>  }; <span class="comment">// class Config</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span> </div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment"></span> </div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   * Implements concept API.  See Config doc header for information on how `*this` behavior is controlled by `config`.</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   *</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   * @param config</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   *</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment">   * @see Struct_reader::Struct_reader(): implemented concept.</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment">   */</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42d9fb1ff01d3acfc5adf01f16abadba">Reader</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">Config</a>&amp; config);</div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment"></span> </div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * Implements concept API.  In this impl: acts essentially identically to shm::Builder::~Builder() dtor:</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   * decrements the owner-process ref-count by 1; if that made it go from 1 to 0 then the underlying</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * SHM-allocated segments are deallocated (possibly asynchronously depending on the SHM provider&#39;s behavior);</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   * but if it went from 2 to 1 then not (shm::Builder dtor is yet to run).  If there are other `Reader`s</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   * in the picture, the ref-count may have grown beyond 2.</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   *</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   * @see Struct_reader::~Struct_reader(): implemented concept.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   */</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a37d334b7f819c2cf9b8d8ec07cb4ad09">~Reader</a>();</div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span> </div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment"></span> </div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   * Implements concept API.  Reminder: you must `.resize()` the returned `Blob` in-place to indicate the</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment">   * size of the actual segment, before attempting deserialization().</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment">   *</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">   * @param max_sz</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   * @see Struct_reader::add_serialization_segment(): implemented concept.</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   */</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span>  flow::util::Blob* <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a2f57ff0e946af136ae3746d317008db5">add_serialization_segment</a>(<span class="keywordtype">size_t</span> max_sz);</div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment"></span> </div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   *</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   * @tparam Struct</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   *        See above.  #Error_code generated:</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   *        struc::error::Code::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS (add_serialization_segment() never called;</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   *        or somehow opposing builder serialized an empty segment list -- this would be a bug on their part),</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   *        struc::error::Code::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED (add_serialization_segment()-returned segment</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment">   *        was modified subsequently to start at a misaligned address; or somehow the opposing</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment">   *        builder supplied a segment that starts at a misaligned address -- this would be a bug on their</span></div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">   *        part),</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">   *        error::Code::S_DESERIALIZE_FAILED_SESSION_HOSED (the SHM-session was unable to determine the location</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   *        of the serialization in SHM, because its `borrow_object()` method indicated the session is down, or the</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   *        information transmitted over IPC was in some way invalid).</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   *</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   * @see Struct_reader::deserialization(): implemented concept.</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   */</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct&gt;</div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span>  <span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">Struct::Reader</a> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223">deserialization</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span> </div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment"></span> </div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">  /// Same as in Heap_reader but this time applied to SHM-stored segments in #m_btm_serialization_shm_handle.</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d">  463</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d">Capnp_heap_engine</a> = ::capnp::SegmentArrayMessageReader;</div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment"></span> </div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">  /// Alias to pointer to #Capnp_heap_engine.</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">  466</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">Capnp_heap_engine_ptr</a> = boost::movelib::unique_ptr&lt;Capnp_heap_engine&gt;;</div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment"></span> </div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   * The data structure populated by shm::Builder counterpart.  Note, in particular, that this uses</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   * the same `Allocator` type.  *However* (as discussed as of this writing inside deserialization())</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   * we use strictly a `const` #Segments_in_shm -- read-only access only -- and therefore never *use*</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   * the actual allocator *object*; only its `pointer` type.  We never use the allocator to allocate or</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   * deallocate inner data of #Segments_in_shm.</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">   *</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   * I state for your informational convenience: As of this writing this is a `list&lt;Basic_blob&gt;`.</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   * `Basic_blob` is very similar to `Blob` used all over the code (just SHM-friendly); and thus it is</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   * a cooler version of `vector&lt;uint8_t&gt;`.</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   */</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">  479</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">Segments_in_shm</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder.html#a7c04e91665590eb6b80d3ae1931765e8">Capnp_message_builder&lt;Arena&gt;::Segments_in_shm_borrowed</a>;</div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment"></span> </div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">  /// Similar to Heap_reader::Capnp_word_array_ptr.</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a67e07b2f8cdaff62e3f7223f4440826e">  482</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a67e07b2f8cdaff62e3f7223f4440826e">Capnp_word_array_ptr</a> = kj::ArrayPtr&lt;const ::capnp::word&gt;;</div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span> </div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment"></span> </div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">  /// See class doc header and ctor doc header.</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#af9f19bfd2d275b3770a3c978ae451c31">  487</a></span><span class="comment"></span>  <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">Session</a> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#af9f19bfd2d275b3770a3c978ae451c31">m_session</a>;</div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment"></span> </div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">  /// The top-serialization reader, namely Heap_reader, of our simple SHM-handle-bearing schema.</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a1edc9404d82d1fe78fd4a892d5dac22c">  490</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">Heap_reader</a> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a1edc9404d82d1fe78fd4a892d5dac22c">m_top_engine</a>;</div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment"></span> </div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">  /// See #Capnp_heap_engine.</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aea972cb0e04d447941d2080c2f2d3a98">  493</a></span><span class="comment"></span>  <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">Capnp_heap_engine_ptr</a> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aea972cb0e04d447941d2080c2f2d3a98">m_btm_engine</a>;</div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment"></span> </div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   * The outer SHM handle to the #Segments_in_shm containing the serialization yielded by payload_msg_builder().</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   * It is null until deserialization() where it&#39;s assigned from `m_session-&gt;borrow_object&lt;T&gt;()`.</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment">   */</span></div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a57144d8e687161731d662b7d7b23fd0e">  499</a></span>  <span class="keyword">typename</span> Arena::template Handle&lt;Segments_in_shm&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a57144d8e687161731d662b7d7b23fd0e">m_btm_serialization_shm_handle</a>;</div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment"></span> </div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">  /// Analogous to Heap_reader::m_capnp_segments; just points into SHM.</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a36e431a3536848c99dd4f55a4d6b1453">  502</a></span><span class="comment"></span>  std::vector&lt;Capnp_word_array_ptr&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a36e431a3536848c99dd4f55a4d6b1453">m_btm_capnp_segments</a>;</div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span>}; <span class="comment">// class Reader</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span> </div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span> </div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment"></span> </div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno"><a class="line" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">  510</a></span><span class="comment"></span><span class="preprocessor">#define TEMPLATE_SHM_BUILDER \</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span><span class="preprocessor">  template&lt;typename Shm_arena&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno"><a class="line" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a6c1d27726471c6aa66a98b8b6b26331c">  513</a></span><span class="comment"></span><span class="preprocessor">#define CLASS_SHM_BUILDER \</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="preprocessor">  Builder&lt;Shm_arena&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno"><a class="line" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa1f45b4161ee9cad33108b8f94f981f5">  516</a></span><span class="comment"></span><span class="preprocessor">#define TEMPLATE_SHM_READER \</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="preprocessor">  template&lt;typename Shm_arena&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno"><a class="line" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa5a44fbd142148023f896d8a16898887">  519</a></span><span class="comment"></span><span class="preprocessor">#define CLASS_SHM_READER \</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="preprocessor">  Reader&lt;Shm_arena&gt;</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span> </div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">// Builder template implementations.</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span> </div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">CLASS_SHM_BUILDER::Builder</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span> </div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a23b111e2bf7be45589eb958d6ccc24f6">  528</a></span><a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">CLASS_SHM_BUILDER::Builder</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html">Config</a>&amp; config) :</div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span> </div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span>  flow::log::Log_context(config.m_logger_ptr, <a class="code hl_enumeration" href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7">Log_component</a>::S_TRANSPORT),</div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span> </div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span>  <span class="comment">// The top-builder engine launched here.  We&#39;ll mutate it ourselves, just a bit, one time in emit_serialization().</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span>  m_top_engine({ get_logger(),</div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span>                 <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html#a2dae5df49d355c6f2199af42fff9befd">S_MAX_SERIALIZATION_SEGMENT_SZ</a>,</div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span>                 config.<a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ab850e04c8a411941c75b74e7c6eccb36">m_top_builder_frame_prefix_sz</a>, config.<a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ae30cd8f4721bccd20ef5f195c332a960">m_top_builder_frame_postfix_sz</a> }),</div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span>  <span class="comment">// The bottom-builder engine launched here.  In the future mutators will cause it to allocate in SHM on-demand.</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span>  m_btm_engine(boost::movelib::make_unique&lt;Capnp_heap_engine&gt;</div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span>                 (get_logger(), config.m_arena))</div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span>{</div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;shm::Builder [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: SHM-heap builder started: &quot;</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span>                 <span class="stringliteral">&quot;SHM-arena (type [&quot;</span> &lt;&lt; <span class="keyword">typeid</span>(Arena).name() &lt;&lt; <span class="stringliteral">&quot;]) [&quot;</span> &lt;&lt; *config.m_arena &lt;&lt; <span class="stringliteral">&quot;]; &quot;</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span>                 <span class="stringliteral">&quot;SHM-session type [&quot;</span> &lt;&lt; <span class="keyword">typeid</span>(Session).name() &lt;&lt; <span class="stringliteral">&quot;]).&quot;</span>);</div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span>}</div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span> </div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">CLASS_SHM_BUILDER::Builder</a>(<a class="code hl_class" href="classStruct__builder__config_1_1Builder.html">Builder</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span> </div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#af2d88517cf0d99186a6062279d6eb0d3">  549</a></span>CLASS_SHM_BUILDER::~Builder()</div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span>{</div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;shm::Builder [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: SHM-heap builder being destroyed.  &quot;</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span>                 <span class="stringliteral">&quot;The subordinate top and/or bottom engines may log more just following this.&quot;</span>);</div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span>}</div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span> </div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a6c1d27726471c6aa66a98b8b6b26331c">CLASS_SHM_BUILDER</a>&amp; CLASS_SHM_BUILDER::operator=(<a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span> </div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#aaeceaccf183170b1785aa240921ae893">  559</a></span><a class="code hl_class" href="classCapnp__msg__builder__interface.html">Capnp_msg_builder_interface</a>* CLASS_SHM_BUILDER::payload_msg_builder()</div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span>{</div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span>  assert(m_btm_engine &amp;&amp; <span class="stringliteral">&quot;Are you operating on a moved-from `*this`?&quot;</span>);</div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span> </div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span>  <span class="keywordflow">return</span> m_btm_engine.get();</div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span>}</div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span> </div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a7909a2d1e1d24037fb8af5338fffa783">  567</a></span><span class="keywordtype">void</span> CLASS_SHM_BUILDER::emit_serialization(<a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#a82a69eaa39cbe8a002de1266f1cbb5cb">Segment_ptrs</a>* target_blobs, <span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d">Session</a>&amp; session,</div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span>                                           <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)<span class="keyword"> const</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span>  <span class="keywordflow">if</span> (flow::error::exec_void_and_throw_on_error</div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span>        ([&amp;](<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* actual_err_code) { emit_serialization(target_blobs, session, actual_err_code); },</div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span>         err_code, <span class="stringliteral">&quot;shm::Builder::emit_serialization()&quot;</span>))</div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span>  {</div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span>  }</div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span>  <span class="comment">// ^-- Call ourselves and return if err_code is null.  If got to present line, err_code is not null.</span></div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span> </div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span>  assert(m_btm_engine &amp;&amp; <span class="stringliteral">&quot;Are you operating on a moved-from `*this`?&quot;</span>);</div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span> </div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span>  <span class="comment">/* Key subtlety: It may seem correct here to do initRoot&lt;&gt;(), not getRoot&lt;&gt;(), but that would be wrong:</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment">   * they may be reusing `*this` (to send it out a 2nd, 3rd, ... time).  Fortunately getRoot&lt;&gt;() does the right</span></div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">   * thing: the 1st time, it&#39;s identical to initRoot&lt;&gt;(); subsequently it&#39;s a no-op that returns the existing</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span><span class="comment">   * root ShmTopSerialization::Builder.  (If getRoot&lt;&gt;() initially barfed instead, we&#39;d have to keep a</span></div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span><span class="comment">   * `bool m_initialized` and do initRoot first and set it to true, then getRoot once it&#39;s true.)</span></div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment">   *</span></div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">   * Also we must either const_cast&lt;&gt;, or make m_top_engine mutable, for the following to compile.</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">   * Of course that is to be questioned; we justify it as follows: getRoot&lt;&gt;() could be done in ctor, and we could</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">   * cache the result there; instead we do it lazily on-demand -- a pattern that&#39;s a typical justification</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span><span class="comment">   * for `mutable` (and the following is essentially a smaller-scoped `mutable`).  The first time it&#39;s done</span></div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span><span class="comment">   * it creates the root (which would otherwise be done in ctor); next time it does nothing; then in either case</span></div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span><span class="comment">   * `root` becomes the same value.</span></div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment">   */</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span>  <span class="keyword">auto</span> root = <span class="keyword">const_cast&lt;</span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a>&amp;<span class="keyword">&gt;</span>(m_top_engine)</div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span>                .payload_msg_builder()-&gt;getRoot&lt;schema::detail::ShmTopSerialization&gt;();</div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span> </div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span>  <span class="comment">/* We have the bottom serialization inside m_btm_engine; the data they&#39;d mutated via this-&gt;payload_msg_builder()</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment">   * is stored in a bunch of SHM segments of whatever sizes was deemed sufficient, all in one STL-compliant</span></div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">   * data structure directly in SHM.  This will finalize that data structure; *and* emit some scalar(s) that encode</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">   * the outer SHM handle to it.  These bits are emitted right into the top</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">   * serialization which will be copied through to the recipient/reader.  (Analogy: They could, instead,</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   * be emitted into a disk file which would be read by the reader.  The file, like this top serialization,</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">   * is small: just a few scalars.  But by following where it points in SHM, we can access an arbitrarily huge</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">   * and complex structure.)  Also it ups the process-owner ref-count from 1 (us) to 2 (us + them), so that our</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">   * dtor won&#39;t blow away the SHM-stored data structure unless Reader has already invoked its dtor too.</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   * (If this is emit_serialization() #2, then the ref-count grows potentially to 3, etc.) */</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span>  <span class="keywordflow">if</span> (!m_btm_engine-&gt;lend(&amp;root, session)) <span class="comment">// Target *root; put the outer SHM handle&#39;s encoding there.</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span>  {</div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span>    *err_code = <a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1error.html#a25a6db383af491442917e2dc8ff944a8a80f5c2d8f8e819b23122a4fa1ea08500">error::Code::S_SERIALIZE_FAILED_SESSION_HOSED</a>;</div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span>    <span class="keywordflow">return</span>; <span class="comment">// It logged already.</span></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span>  }</div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span> </div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span>  <span class="comment">/* Secondly obtain that resulting top (local-heap) serialization.  This will emit error as needed.</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span><span class="comment">   * In reality there is only one possible error condition (as documented): S_INTERNAL_ERROR_SERIALIZE_LEAF_TOO_BIG.</span></div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span><span class="comment">   * It is essentially impossible in our case: m_btm_engine always emits a quite-small, constant-sized serialization</span></div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span><span class="comment">   * for its SHM handle thingie; it will easily fit into any reasonable first segment and not even require any</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment">   * further segments, let alone overflow any segment.</span></div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">   *</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span><span class="comment">   * If this is emit_serialization() #2, #3, ...: This value will always be the same, since it&#39;s just the SHM handle&#39;s</span></div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment">   * encoding; at least for the 2 SHM providers (SHM-classic, SHM-jemalloc) that&#39;s the case, and I (ygoldfel) can&#39;t</span></div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">   * conceive of anything different.  @todo Considering simply no-op-ing here for any emit_serialization()s except the</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">   * first one.  It&#39;s not urgent, probably, as despite looking fancy, in this case the insides of the following call</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">   * will barely do any work. */</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span><span class="preprocessor">#ifndef NDEBUG</span></div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno">  625</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> n_target_blobs_orig = target_blobs-&gt;size();</div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span>  m_top_engine.emit_serialization(target_blobs, <a class="code hl_variable" href="namespaceipc_1_1transport_1_1struc.html#ac70446757444f864afa21a5062bc5b0d">NULL_SESSION</a>, err_code);</div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span> </div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span>  assert((*err_code</div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span>          || (target_blobs-&gt;size() == (n_target_blobs_orig + 1)))</div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span>         &amp;&amp; <span class="stringliteral">&quot;We guarantee the top serialization consists of exactly 1 segment (storing SHM handle), no more.&quot;</span>);</div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span>} <span class="comment">// Builder::emit_serialization()</span></div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span> </div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a8f01bec0e66080850379df98a2ecf99e">  635</a></span><span class="keywordtype">size_t</span> CLASS_SHM_BUILDER::n_serialization_segments()<span class="keyword"> const</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span>  assert(m_btm_engine &amp;&amp; <span class="stringliteral">&quot;Are you operating on a moved-from `*this`?&quot;</span>);</div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span> </div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span>  <span class="keywordflow">return</span> 1; <span class="comment">// Just the one handle!  See the end of emit_serialization().</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span>}</div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span> </div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a705eab4975089bdd7c6d961b079a2252">  643</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1transport_1_1struc_1_1shm.html#ac4969b49016844f884240b81ee1ab180">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a6c1d27726471c6aa66a98b8b6b26331c">CLASS_SHM_BUILDER</a>&amp; val)</div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span>{</div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span>  <span class="keywordflow">return</span> os &lt;&lt; <span class="charliteral">&#39;@&#39;</span> &lt;&lt; &amp;val;</div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span>}</div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span> </div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span><span class="comment">// Reader template implementations.</span></div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span> </div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa1f45b4161ee9cad33108b8f94f981f5">TEMPLATE_SHM_READER</a></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42d9fb1ff01d3acfc5adf01f16abadba">  651</a></span><a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">CLASS_SHM_READER::Reader</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">Config</a>&amp; config) :</div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span>  flow::log::Log_context(config.m_logger_ptr, <a class="code hl_enumeration" href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7">Log_component</a>::S_TRANSPORT),</div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span> </div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span>  m_session(config.m_session),</div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span>  m_top_engine({ get_logger(), 1 }) <span class="comment">// 1 segment is sufficient for 1 damned handle.</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span>  <span class="comment">/* m_btm_engine null until deserialization().</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   * m_btm_serialization_shm_handle, ditto. */</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span>{</div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;shm::Reader [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: SHM-heap reader started: &quot;</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span>                 <span class="stringliteral">&quot;SHM-arena type [&quot;</span> &lt;&lt; <span class="keyword">typeid</span>(Arena).name() &lt;&lt; <span class="stringliteral">&quot;]; &quot;</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span>                 <span class="stringliteral">&quot;SHM-session (type [&quot;</span> &lt;&lt; <span class="keyword">typeid</span>(*config.m_session).name() &lt;&lt; <span class="stringliteral">&quot;]) [&quot;</span> &lt;&lt; *config.m_session &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span>}</div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span> </div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa1f45b4161ee9cad33108b8f94f981f5">TEMPLATE_SHM_READER</a></div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a37d334b7f819c2cf9b8d8ec07cb4ad09">  665</a></span>CLASS_SHM_READER::~Reader()</div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span>{</div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;shm::Reader [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: SHM-heap reader being destroyed.  &quot;</span></div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span>                 <span class="stringliteral">&quot;The subordinate top and/or bottom engines may log more just following this.&quot;</span>);</div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span>}</div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span> </div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa1f45b4161ee9cad33108b8f94f981f5">TEMPLATE_SHM_READER</a></div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a2f57ff0e946af136ae3746d317008db5">  672</a></span>flow::util::Blob* CLASS_SHM_READER::add_serialization_segment(<span class="keywordtype">size_t</span> max_sz)</div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span>{</div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno">  674</span>  <span class="comment">/* The top serialization is simply this (but what it encodes is a handle to the bottom serialization).</span></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span><span class="comment">   * It would be very surprising if this were called more than once per *this. */</span></div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span>  <span class="keywordflow">return</span> m_top_engine.add_serialization_segment(max_sz);</div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span>}</div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span> </div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa1f45b4161ee9cad33108b8f94f981f5">TEMPLATE_SHM_READER</a></div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct&gt;</div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223">  681</a></span><span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">Struct::Reader</a> CLASS_SHM_READER::deserialization(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span>{</div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span>  <span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>;</div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span>  <span class="keyword">using </span>Blob = flow::util::Blob_sans_log_context;</div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span>  <span class="keyword">using </span>flow::error::Runtime_error;</div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span>  <span class="keyword">using </span>flow::util::buffers_dump_string;</div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span>  <span class="keyword">using </span>boost::movelib::make_unique;</div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span>  <span class="keyword">using </span>std::vector;</div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span>  using ::capnp::word;</div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span>  <span class="keyword">using </span>Capnp_word_array_array_ptr = kj::ArrayPtr&lt;const Capnp_word_array_ptr&gt;;</div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span>  <span class="keyword">using </span>Capnp_struct_reader = <span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">Struct::Reader</a>;</div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span>  <span class="keyword">using </span>Capnp_heap_engine_opts = ::capnp::ReaderOptions;</div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span> </div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span>  <span class="comment">/* When constructing a MessageReader, it takes this ReaderOptions struct which defaults to certain values.</span></div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span><span class="comment">   * In typical capnp use the user would do this themselves; but in our case we do it for them.</span></div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span><span class="comment">   * @todo This should be part of our public API throughout (where relevant).  Surely a ticket is filed.  Until then:</span></div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span><span class="comment">   * The defaults seem fine, except:</span></div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span><span class="comment">   * The particular traversalLimitInWords option can cause trouble with large structures.  (See capnp source message.h</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span><span class="comment">   * for its official docs.)  It is a security feature for stuff transmitted over the wire; but as of *this* writing</span></div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span><span class="comment">   * we do local IPC and explicitly assume trust.  So until this is made configurable (and it really should be)</span></div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment">   * it&#39;s an OK work-around to just shove a giant value here.  Otherwise the mere act of reading a structure with</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span><span class="comment">   * many sub-structs (in absolute terms, not in terms of depth) can (and has, such as in our test suite&#39;s perf_demo)</span></div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span><span class="comment">   * throw a capnp exception. */</span></div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span>  <span class="keyword">constexpr</span> Capnp_heap_engine_opts RDR_OPTIONS = { std::numeric_limits&lt;uint64_t&gt;::max() / <span class="keyword">sizeof</span>(word),</div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span>                                                   Capnp_heap_engine_opts{}.nestingLimit };</div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span> </div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span>  <span class="comment">/* Helper to emit error via usual semantics.  We return a ref so can&#39;t use FLOW_ERROR_EXEC_AND_THROW_ON_ERROR().</span></div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span><span class="comment">   * @todo Wait... we don&#39;t return a ref.  Small maintenance mistake?  Fix it up. */</span></div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span>  <span class="keyword">const</span> <span class="keyword">auto</span> emit_error = [&amp;](<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&amp; our_err_code) -&gt; Capnp_struct_reader</div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span>  {</div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span>    <span class="keywordflow">if</span> (err_code)</div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span>    {</div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span>      *err_code = our_err_code;</div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span>      <span class="keywordflow">return</span> Capnp_struct_reader();</div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span>    }</div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span>    <span class="keywordflow">throw</span> Runtime_error(our_err_code, <span class="stringliteral">&quot;shm::Reader::deserialization()&quot;</span>);</div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span>    <span class="keywordflow">return</span> Capnp_struct_reader(); <span class="comment">// Doesn&#39;t get here.</span></div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span>  };</div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span> </div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span>  <span class="comment">// The top serialization is simply this (but what it encodes is a handle to the bottom serialization).</span></div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span>  <span class="keyword">const</span> <span class="keyword">auto</span> top_serialization_root</div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span>    = m_top_engine.deserialization&lt;schema::detail::ShmTopSerialization&gt;(err_code);</div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno">  724</span>  <span class="comment">// Either that threw (error), set *err_code to truthy (error), or succeeded.  Check for that middle one.</span></div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span> </div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span>  <span class="keywordflow">if</span> (*err_code)</div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span>  {</div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span>    <span class="keywordflow">return</span> Capnp_struct_reader();</div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span>  }</div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span> </div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno">  732</span>  assert((!m_btm_serialization_shm_handle) &amp;&amp; <span class="stringliteral">&quot;Did you call deserialization() more than once?&quot;</span>);</div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span> </div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span>  <span class="comment">/* Now get the bottom serialization out of SHM.  To do so, really we mirror what Heap_reader does --</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span><span class="comment">   * SegmentArrayReader and all that -- but instead of getting it out of direct-serialized stuff from segments in</span></div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span><span class="comment">   * regular heap, get it out of SHM based on the handle to list&lt;Basic_blob&gt;, where that handle is</span></div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span><span class="comment">   * the one little thing stored in top_serialization_root. */</span></div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span>  {</div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span>    <span class="comment">// top_serialization_root is a ShmTopSerialization::Reader.</span></div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno">  740</span>    <span class="keyword">const</span> <span class="keyword">auto</span> capnp_blob_reader = top_serialization_root.getSegmentListInShm();</div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span>    Blob handle_serialization_blob;</div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span>    <a class="code hl_function" href="namespaceipc_1_1transport_1_1struc_1_1shm.html#adb38fe88cfd5e758ef52c482d2902669">capnp_get_shm_handle_to_borrow</a>(capnp_blob_reader, &amp;handle_serialization_blob);</div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span> </div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span>    <span class="comment">/* And, as documented in the .capnp file -- and can be seen in Builder -- the handle is</span></div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span><span class="comment">     * to Segments_in_shm, which is the aforementioned list&lt;Basic_blob&gt;.  So interpret it that way</span></div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span><span class="comment">     * (but read-only: we will never modify it, even if *m_arena is opened for read-write). */</span></div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno">  747</span>    m_btm_serialization_shm_handle = m_session-&gt;template borrow_object&lt;Segments_in_shm&gt;(handle_serialization_blob);</div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span>  }</div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span>  <span class="keywordflow">if</span> (!m_btm_serialization_shm_handle)</div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span>  {</div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span>    <span class="keywordflow">return</span> emit_error(<a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1error.html#a25a6db383af491442917e2dc8ff944a8a193ecb77fe093a4d59f5fafe68389624">error::Code::S_DESERIALIZE_FAILED_SESSION_HOSED</a>);</div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span>  }</div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span> </div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span>  <span class="comment">/* Subtlety: We are about to work with serialization_segments, an STL-compliant structure stored directly in</span></div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span><span class="comment">   * SHM.  In so doing we&#39;ll have to traverse it with iterators and so on.  Needn&#39;t we do some kind of</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span><span class="comment">   * Stateless_allocator/Arena_activator context-setting (e.g., as shm::Capnp_message_builder does when building</span></div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span><span class="comment">   * up the thing we&#39;re now reading)?  If so, we have a problem: what &quot;arena&quot; do we even activate?  Fortunately</span></div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span><span class="comment">   * (and it&#39;s not a fortunate happenstance thing but rather makes sense in terms of the generic asymmetric design</span></div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span><span class="comment">   * that separates the write-side Arena and the -- in our case -- read Session) we in fact needn&#39;t.  This bears</span></div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span><span class="comment">   * explanation for context:</span></div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span><span class="comment">   *</span></div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span><span class="comment">   * Our access to this STL-compliant data structure is read-only.  Our ref is formally to a const</span></div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno">  764</span><span class="comment">   * list-of-vectors-of-bytes (note: not a const list-of-POINTERS-to-vectors-of-bytes).  Anything we do will *not*</span></div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span><span class="comment">   * invoke any &lt;allocator&gt;.&lt;do stuff -- allocate/deallocate()&gt;() calls.  It will certainly access</span></div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span><span class="comment">   * &lt;allocator&gt;::pointer *type* which will invoke (crucially!) the proper fancy-pointer logic to dereference SHM-stored</span></div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span><span class="comment">   * (not raw T*) pointers which allows following iterators among other things; but that ::pointer must be able</span></div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span><span class="comment">   * to generate raw pointers (deref itself) without any context-setting help.  So: we are fine.</span></div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span><span class="comment">   *</span></div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span><span class="comment">   * While the following question is not formally relevant to the present code, one might still wonder, so I&#39;ll</span></div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span><span class="comment">   * comment on it: What about the destruction of this data structure down the line, like in our dtor when</span></div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span><span class="comment">   * we let go of m_btm_serialization_shm_handle?  If that is the last owner process to hold the cross-process</span></div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span><span class="comment">   * handle to this in-SHM structure, won&#39;t &quot;it&quot; need to call its (list-of-vectors or w/e) dtor?  And if so</span></div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span><span class="comment">   * doesn&#39;t &quot;something&quot; need to set the allocator-context before the dtor is called?  Well, firstly, when</span></div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span><span class="comment">   * the Handle logic, in some process, decides it&#39;s time to call the dtor, it is in charge of setting the</span></div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno">  776</span><span class="comment">   * allocator-context.  So somehow it must do the right thing.  But for general education, how *does* it do the</span></div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span><span class="comment">   * right thing?  It&#39;s easiest to answer on the level of specific impls.</span></div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span><span class="comment">   *   - shm::classic::Pool_arena: This simple symmetric core class is both Arena and Session, and both sides</span></div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span><span class="comment">   *     (in our case the builder and the reader) open the same-named SHM pool in identical ways.</span></div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span><span class="comment">   *     In its case cross-process ref-count-0 is detected by either process; and whichever one it is</span></div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span><span class="comment">   *     simply sets itself (Arena::this) as the allocator-context before invoking dtor.  So if it&#39;s us, the reader</span></div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span><span class="comment">   *     process, then it&#39;ll do that.  This was ensured when *we* called Session::borrow_object(), which invisibly</span></div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno">  783</span><span class="comment">   *     supplied the custom deleter which will in fact do what I just described.  This Session::borrow_object(),</span></div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span><span class="comment">   *     really, what is it?  It&#39;s shm::classic::Pool_arena::borrow_object(), because Session = Pool_arena.</span></div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span><span class="comment">   *   - SHM-jemalloc provider: This asymmetric setup involves, on the builder side, an Arena and a separate</span></div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno">  786</span><span class="comment">   *     Session; and on the reader side a Session that is able to interpret the opposing Session&#39;s</span></div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span><span class="comment">   *     Session::lend_object() in its Session::borrow_object().  The reader-side Session::borrow_object() will set</span></div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span><span class="comment">   *     up a custom deleter, as it must, and that guy will (internally) IPC-inform the builder side Session that our</span></div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span><span class="comment">   *     local Handle ref-count=0.  Hence the builder side is in charge of invoking the dtor, when the time comes,</span></div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span><span class="comment">   *     regardless of which side was last to local ref-count=0.</span></div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno">  791</span><span class="comment">   *</span></div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno">  792</span><span class="comment">   * Specifics aside, generically speaking: The custom deleter on the Handle is in charge of safely disposing</span></div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno">  793</span><span class="comment">   * of the structure when no other holder holds it any longer either -- and it can do it however it needs to.</span></div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno">  794</span><span class="comment">   * Part of its charge is to -- when it indeed invokes the STL-compliant structure&#39;s dtor -- set the proper</span></div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno">  795</span><span class="comment">   * allocator-context to ensure the inner data are disposed of properly first. */</span></div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno">  796</span> </div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno">  797</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">Segments_in_shm</a>&amp; serialization_segments = *m_btm_serialization_shm_handle; <span class="comment">// Attn: const!</span></div>
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno">  798</span>  <span class="comment">// OK!  So now just do the usual SegmentArrayReader stuff as mentioned above (similarly to Heap_reader).</span></div>
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno">  799</span> </div>
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno">  800</span>  <span class="keywordflow">if</span> (serialization_segments.empty())</div>
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno">  801</span>  {</div>
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno">  802</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;shm::Reader [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: The top serialization was valid; and the SHM handle &quot;</span></div>
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno">  803</span>                     <span class="stringliteral">&quot;therein does point to a list of segments; but that list is empty.  Emitting error.  &quot;</span></div>
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno">  804</span>                     <span class="stringliteral">&quot;Other side misbehaved?&quot;</span>);</div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span>    <span class="keywordflow">return</span> emit_error(<a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b">struc::error::Code::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</a>);</div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno">  806</span>  }</div>
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno">  807</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno">  808</span> </div>
<div class="line"><a id="l00809" name="l00809"></a><span class="lineno">  809</span>  <span class="keyword">auto</span>&amp; capnp_segs = m_btm_capnp_segments;</div>
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno">  810</span>  assert(capnp_segs.empty());</div>
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno">  811</span>  capnp_segs.reserve(serialization_segments.size());</div>
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno">  812</span> </div>
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno">  813</span>  <span class="keywordtype">size_t</span> idx = 0;</div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; serialization_segment : serialization_segments) <span class="comment">// Reminder: serialization_segment is a Basic_blob.</span></div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span>  {</div>
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno">  816</span>    <span class="keyword">const</span> uint8_t* data_ptr = &amp;(serialization_segment.front());</div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno">  817</span>    <span class="keyword">const</span> <span class="keywordtype">size_t</span> seg_size = serialization_segment.size();</div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno">  818</span> </div>
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno">  819</span>    <span class="keywordflow">if</span> ((uintptr_t(data_ptr) % <span class="keyword">sizeof</span>(<span class="keywordtype">void</span>*)) != 0)</div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno">  820</span>    {</div>
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno">  821</span>      FLOW_LOG_WARNING(<span class="stringliteral">&quot;shm::Reader [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span>                       <span class="stringliteral">&quot;Serialization segment [&quot;</span> &lt;&lt; idx &lt;&lt; <span class="stringliteral">&quot;] &quot;</span></div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno">  823</span>                       <span class="stringliteral">&quot;(0-based, of [&quot;</span> &lt;&lt; serialization_segments.size() &lt;&lt; <span class="stringliteral">&quot;], 1-based): &quot;</span></div>
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno">  824</span>                       <span class="stringliteral">&quot;SHM-heap buffer @[&quot;</span> &lt;&lt; <span class="keyword">static_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(data_ptr) &lt;&lt; <span class="stringliteral">&quot;] sized [&quot;</span> &lt;&lt; seg_size &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00825" name="l00825"></a><span class="lineno">  825</span>                       <span class="stringliteral">&quot;Starting pointer is not this-architecture-word-aligned.  Bug?  &quot;</span></div>
<div class="line"><a id="l00826" name="l00826"></a><span class="lineno">  826</span>                       <span class="stringliteral">&quot;Misuse of Builder?  Other side misbehaved?  &quot;</span></div>
<div class="line"><a id="l00827" name="l00827"></a><span class="lineno">  827</span>                       <span class="stringliteral">&quot;Misalignment is against the API use requirements; capnp would complain and fail.&quot;</span>);</div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno">  828</span>      <span class="keywordflow">return</span> emit_error(<a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406">struc::error::Code::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</a>);</div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span>    }</div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno">  830</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span> </div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span>    FLOW_LOG_TRACE(<span class="stringliteral">&quot;shm::Reader [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno">  833</span>                   <span class="stringliteral">&quot;Serialization segment [&quot;</span> &lt;&lt; idx &lt;&lt; <span class="stringliteral">&quot;] &quot;</span></div>
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno">  834</span>                   <span class="stringliteral">&quot;(0-based, of [&quot;</span> &lt;&lt; serialization_segments.size() &lt;&lt; <span class="stringliteral">&quot;], 1-based): &quot;</span></div>
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno">  835</span>                   <span class="stringliteral">&quot;SHM-heap buffer @[&quot;</span> &lt;&lt; <span class="keyword">static_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(data_ptr) &lt;&lt; <span class="stringliteral">&quot;] sized [&quot;</span> &lt;&lt; seg_size &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno">  836</span>                   <span class="stringliteral">&quot;Feeding into capnp deserialization engine.&quot;</span>);</div>
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno">  837</span>    FLOW_LOG_DATA(<span class="stringliteral">&quot;Segment contents: &quot;</span></div>
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno">  838</span>                  <span class="stringliteral">&quot;[\n&quot;</span> &lt;&lt; buffers_dump_string(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">Blob_const</a>(data_ptr, seg_size), <span class="stringliteral">&quot;  &quot;</span>) &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno">  839</span> </div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno">  840</span>    capnp_segs.emplace_back(<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>word*<span class="keyword">&gt;</span>(data_ptr),</div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno">  841</span>                            seg_size / <span class="keyword">sizeof</span>(word)); <span class="comment">// @todo Maybe also check that seg_size = a multiple?  assert()?</span></div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno">  842</span> </div>
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno">  843</span>    ++idx;</div>
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno">  844</span>  } <span class="comment">// for (const auto&amp; serialization_segment : serialization_segments)</span></div>
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno">  845</span> </div>
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno">  846</span>  <span class="comment">/* Initialize the deserialization engine by giving it the pointers to/size of the backing segment blobs.</span></div>
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno">  847</span><span class="comment">   * It doesn&#39;t copy this array of pointers/sizes, so that array must stay alive, hence why capnp_segs is</span></div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno">  848</span><span class="comment">   * really m_capnp_segments.  To be clear: not only must the blobs stay alive, but so must the array referring</span></div>
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno">  849</span><span class="comment">   * to them. */</span></div>
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno">  850</span>  <span class="keyword">const</span> Capnp_word_array_array_ptr capnp_segs_ptr(&amp;(capnp_segs.front()), capnp_segs.size());</div>
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno">  851</span>  m_btm_engine = make_unique&lt;Capnp_heap_engine&gt;(capnp_segs_ptr, RDR_OPTIONS);</div>
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno">  852</span> </div>
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno">  853</span>  assert(((!err_code) || (!*err_code)) &amp;&amp; <span class="stringliteral">&quot;*err_code should have been cleared above (unless null).&quot;</span>);</div>
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno">  854</span> </div>
<div class="line"><a id="l00855" name="l00855"></a><span class="lineno">  855</span>  <span class="comment">// And lastly set up the structured-accessor API object that&#39;ll traverse those blobs via that engine.</span></div>
<div class="line"><a id="l00856" name="l00856"></a><span class="lineno">  856</span>  <span class="keywordflow">return</span> m_btm_engine-&gt;getRoot&lt;Struct&gt;();</div>
<div class="line"><a id="l00857" name="l00857"></a><span class="lineno">  857</span>} <span class="comment">// Reader::deserialization()</span></div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno">  858</span> </div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno">  859</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa1f45b4161ee9cad33108b8f94f981f5">TEMPLATE_SHM_READER</a></div>
<div class="line"><a id="l00860" name="l00860"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a6aed71b2ab83f2a087d66562ea2962b9">  860</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1transport_1_1struc_1_1shm.html#ac4969b49016844f884240b81ee1ab180">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_define" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa5a44fbd142148023f896d8a16898887">CLASS_SHM_READER</a>&amp; val)</div>
<div class="line"><a id="l00861" name="l00861"></a><span class="lineno">  861</span>{</div>
<div class="line"><a id="l00862" name="l00862"></a><span class="lineno">  862</span>  <span class="keywordflow">return</span> os &lt;&lt; <span class="charliteral">&#39;@&#39;</span> &lt;&lt; &amp;val;</div>
<div class="line"><a id="l00863" name="l00863"></a><span class="lineno">  863</span>}</div>
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno">  864</span> </div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno">  865</span><span class="preprocessor">#undef TEMPLATE_SHM_BUILDER</span></div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno">  866</span><span class="preprocessor">#undef CLASS_SHM_BUILDER</span></div>
<div class="line"><a id="l00867" name="l00867"></a><span class="lineno">  867</span><span class="preprocessor">#undef TEMPLATE_SHM_READDER</span></div>
<div class="line"><a id="l00868" name="l00868"></a><span class="lineno">  868</span><span class="preprocessor">#undef CLASS_SHM_READER</span></div>
<div class="line"><a id="l00869" name="l00869"></a><span class="lineno">  869</span> </div>
<div class="line"><a id="l00870" name="l00870"></a><span class="lineno">  870</span>} <span class="comment">// namespace ipc::transport::struc::shm</span></div>
<div class="ttc" id="acapnp__msg__builder_8hpp_html"><div class="ttname"><a href="capnp__msg__builder_8hpp.html">capnp_msg_builder.hpp</a></div></div>
<div class="ttc" id="aclassCapnp__msg__builder__interface_html"><div class="ttname"><a href="classCapnp__msg__builder__interface.html">Capnp_msg_builder_interface</a></div></div>
<div class="ttc" id="aclassStruct__builder__config_1_1Builder_html"><div class="ttname"><a href="classStruct__builder__config_1_1Builder.html">Builder</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">ipc::transport::struc::Heap_fixed_builder</a></div><div class="ttdoc">Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in th...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00130">heap_serializer.hpp:132</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">ipc::transport::struc::Heap_reader</a></div><div class="ttdoc">Implements Struct_reader concept by straightforwardly interpreting a serialization by Heap_fixed_buil...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00324">heap_serializer.hpp:327</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder__base_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html">ipc::transport::struc::shm::Builder_base</a></div><div class="ttdoc">shm::Builder base that contains non-parameterized public items such as tag types and constants.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00033">serializer.hpp:34</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder__base_html_a2dae5df49d355c6f2199af42fff9befd"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder__base.html#a2dae5df49d355c6f2199af42fff9befd">ipc::transport::struc::shm::Builder_base::S_MAX_SERIALIZATION_SEGMENT_SZ</a></div><div class="ttdeci">static constexpr size_t S_MAX_SERIALIZATION_SEGMENT_SZ</div><div class="ttdoc">A message of this size will be able to completely contain the (single) segment emitted by Builder::em...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00048">serializer.hpp:48</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">ipc::transport::struc::shm::Builder</a></div><div class="ttdoc">Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00124">serializer.hpp:127</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a1f6e7a9e4b810d1737fdb24240e227c1"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a1f6e7a9e4b810d1737fdb24240e227c1">ipc::transport::struc::shm::Builder::operator=</a></div><div class="ttdeci">Builder &amp; operator=(Builder &amp;&amp;src)</div><div class="ttdoc">Implements concept API.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a2156d8a6653b0f4a43bb8eaf4806536a"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2156d8a6653b0f4a43bb8eaf4806536a">ipc::transport::struc::shm::Builder::operator=</a></div><div class="ttdeci">Builder &amp; operator=(const Builder &amp;)=delete</div><div class="ttdoc">Disallow copy assignment.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a2d9808d9b0c04cf84c8e439b1643506d"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d">ipc::transport::struc::shm::Builder::Session</a></div><div class="ttdeci">session::shm::Arena_to_shm_session_t&lt; Arena &gt; * Session</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00181">serializer.hpp:181</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a3283aa7dc43b3851b94ff65f1f01d5e1"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a3283aa7dc43b3851b94ff65f1f01d5e1">ipc::transport::struc::shm::Builder::m_top_engine</a></div><div class="ttdeci">Heap_fixed_builder m_top_engine</div><div class="ttdoc">The top-serialization builder, namely Heap_fixed_builder, of our simple SHM-handle-bearing schema.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00313">serializer.hpp:313</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a785a61db43b5f6ee486863eb0f0a56c4"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a785a61db43b5f6ee486863eb0f0a56c4">ipc::transport::struc::shm::Builder::Builder</a></div><div class="ttdeci">Builder(const Builder &amp;)=delete</div><div class="ttdoc">Disallow copy construction.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a7909a2d1e1d24037fb8af5338fffa783"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a7909a2d1e1d24037fb8af5338fffa783">ipc::transport::struc::shm::Builder::emit_serialization</a></div><div class="ttdeci">void emit_serialization(Segment_ptrs *target_blobs, const Session &amp;session, Error_code *err_code=0) const</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00567">serializer.hpp:567</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a828d2e04ba4f62e30ae14518dd33dd63"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a828d2e04ba4f62e30ae14518dd33dd63">ipc::transport::struc::shm::Builder::m_btm_engine</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Capnp_heap_engine &gt; m_btm_engine</div><div class="ttdoc">See Capnp_heap_engine.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00328">serializer.hpp:328</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a8f01bec0e66080850379df98a2ecf99e"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a8f01bec0e66080850379df98a2ecf99e">ipc::transport::struc::shm::Builder::n_serialization_segments</a></div><div class="ttdeci">size_t n_serialization_segments() const</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00635">serializer.hpp:635</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a9374ce7f0dc46bb841d9359df5d4045f"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9374ce7f0dc46bb841d9359df5d4045f">ipc::transport::struc::shm::Builder::Builder</a></div><div class="ttdeci">Builder()</div><div class="ttdoc">Implements concept API.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_a9bc898884381eebdb03f0dd9f74895de"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a9bc898884381eebdb03f0dd9f74895de">ipc::transport::struc::shm::Builder::Arena</a></div><div class="ttdeci">Shm_arena Arena</div><div class="ttdoc">Short-hand for Shm_arena template param.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00132">serializer.hpp:132</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_aaeceaccf183170b1785aa240921ae893"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#aaeceaccf183170b1785aa240921ae893">ipc::transport::struc::shm::Builder::payload_msg_builder</a></div><div class="ttdeci">Capnp_msg_builder_interface * payload_msg_builder()</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00559">serializer.hpp:559</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_ac5d54e207503b67b6d2d75c5eb44e76d"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#ac5d54e207503b67b6d2d75c5eb44e76d">ipc::transport::struc::shm::Builder::Builder</a></div><div class="ttdeci">Builder(Builder &amp;&amp;src)</div><div class="ttdoc">Implements concept API.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Builder_html_af2d88517cf0d99186a6062279d6eb0d3"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#af2d88517cf0d99186a6062279d6eb0d3">ipc::transport::struc::shm::Builder::~Builder</a></div><div class="ttdeci">~Builder()</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00549">serializer.hpp:549</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder.html">ipc::transport::struc::shm::Capnp_message_builder</a></div><div class="ttdoc">A capnp::MessageBuilder used by shm::Builder: similar to a MallocMessageBuilder with the GROW_HEURIST...</div><div class="ttdef"><b>Definition:</b> <a href="capnp__msg__builder_8hpp_source.html#l00066">capnp_msg_builder.hpp:69</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder_html_a7c04e91665590eb6b80d3ae1931765e8"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder.html#a7c04e91665590eb6b80d3ae1931765e8">ipc::transport::struc::shm::Capnp_message_builder::Segments_in_shm_borrowed</a></div><div class="ttdeci">bipc::list&lt; Segment_in_shm_borrowed, Borrower_allocator&lt; Segment_in_shm_borrowed &gt; &gt; Segments_in_shm_borrowed</div><div class="ttdoc">For easier outside generic programming, this is the read-only-borrower counterpart to Segments_in_shm...</div><div class="ttdef"><b>Definition:</b> <a href="capnp__msg__builder_8hpp_source.html#l00144">capnp_msg_builder.hpp:144</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a></div><div class="ttdoc">Implements Struct_reader concept by interpreting a serialization by shm::Builder with the same templa...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00365">serializer.hpp:368</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a1edc9404d82d1fe78fd4a892d5dac22c"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a1edc9404d82d1fe78fd4a892d5dac22c">ipc::transport::struc::shm::Reader::m_top_engine</a></div><div class="ttdeci">Heap_reader m_top_engine</div><div class="ttdoc">The top-serialization reader, namely Heap_reader, of our simple SHM-handle-bearing schema.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00490">serializer.hpp:490</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a2f57ff0e946af136ae3746d317008db5"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a2f57ff0e946af136ae3746d317008db5">ipc::transport::struc::shm::Reader::add_serialization_segment</a></div><div class="ttdeci">flow::util::Blob * add_serialization_segment(size_t max_sz)</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00672">serializer.hpp:672</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a36e431a3536848c99dd4f55a4d6b1453"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a36e431a3536848c99dd4f55a4d6b1453">ipc::transport::struc::shm::Reader::m_btm_capnp_segments</a></div><div class="ttdeci">std::vector&lt; Capnp_word_array_ptr &gt; m_btm_capnp_segments</div><div class="ttdoc">Analogous to Heap_reader::m_capnp_segments; just points into SHM.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00502">serializer.hpp:502</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a37d334b7f819c2cf9b8d8ec07cb4ad09"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a37d334b7f819c2cf9b8d8ec07cb4ad09">ipc::transport::struc::shm::Reader::~Reader</a></div><div class="ttdeci">~Reader()</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00665">serializer.hpp:665</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a42c8e0c8210121f3969aeb019df5c5b3"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3">ipc::transport::struc::shm::Reader::Arena</a></div><div class="ttdeci">Shm_arena Arena</div><div class="ttdoc">Short-hand for Shm_arena template param.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00373">serializer.hpp:373</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a42d9fb1ff01d3acfc5adf01f16abadba"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42d9fb1ff01d3acfc5adf01f16abadba">ipc::transport::struc::shm::Reader::Reader</a></div><div class="ttdeci">Reader(const Config &amp;config)</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00651">serializer.hpp:651</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a4bf6b31e4a5896d7ecc3236f1498602d"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d">ipc::transport::struc::shm::Reader::Capnp_heap_engine</a></div><div class="ttdeci">::capnp::SegmentArrayMessageReader Capnp_heap_engine</div><div class="ttdoc">Same as in Heap_reader but this time applied to SHM-stored segments in m_btm_serialization_shm_handle...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00463">serializer.hpp:463</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a4c0a2d000e3994b7eeec3064112dcc5e"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">ipc::transport::struc::shm::Reader::Segments_in_shm</a></div><div class="ttdeci">typename Capnp_message_builder&lt; Arena &gt;::Segments_in_shm_borrowed Segments_in_shm</div><div class="ttdoc">The data structure populated by shm::Builder counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00479">serializer.hpp:479</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a57144d8e687161731d662b7d7b23fd0e"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a57144d8e687161731d662b7d7b23fd0e">ipc::transport::struc::shm::Reader::m_btm_serialization_shm_handle</a></div><div class="ttdeci">Arena::template Handle&lt; Segments_in_shm &gt; m_btm_serialization_shm_handle</div><div class="ttdoc">The outer SHM handle to the Segments_in_shm containing the serialization yielded by payload_msg_build...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00499">serializer.hpp:499</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_a67e07b2f8cdaff62e3f7223f4440826e"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a67e07b2f8cdaff62e3f7223f4440826e">ipc::transport::struc::shm::Reader::Capnp_word_array_ptr</a></div><div class="ttdeci">kj::ArrayPtr&lt; const ::capnp::word &gt; Capnp_word_array_ptr</div><div class="ttdoc">Similar to Heap_reader::Capnp_word_array_ptr.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00482">serializer.hpp:482</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_aceb5816f4e9f312a8ce2ef17feb81223"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223">ipc::transport::struc::shm::Reader::deserialization</a></div><div class="ttdeci">Struct::Reader deserialization(Error_code *err_code=0)</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00681">serializer.hpp:681</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_ae4b859bec8f09d37cb041a8ee40c5007"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">ipc::transport::struc::shm::Reader::Capnp_heap_engine_ptr</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Capnp_heap_engine &gt; Capnp_heap_engine_ptr</div><div class="ttdoc">Alias to pointer to Capnp_heap_engine.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00466">serializer.hpp:466</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_ae77502abf0b04ad7543266fc6c34f49d"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">ipc::transport::struc::shm::Reader::Session</a></div><div class="ttdeci">typename Builder&lt; Shm_arena &gt;::Session Session</div><div class="ttdoc">See shm::Builder::Session.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00376">serializer.hpp:376</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_aea972cb0e04d447941d2080c2f2d3a98"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aea972cb0e04d447941d2080c2f2d3a98">ipc::transport::struc::shm::Reader::m_btm_engine</a></div><div class="ttdeci">Capnp_heap_engine_ptr m_btm_engine</div><div class="ttdoc">See Capnp_heap_engine.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00493">serializer.hpp:493</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1shm_1_1Reader_html_af9f19bfd2d275b3770a3c978ae451c31"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#af9f19bfd2d275b3770a3c978ae451c31">ipc::transport::struc::shm::Reader::m_session</a></div><div class="ttdeci">Session m_session</div><div class="ttdoc">See class doc header and ctor doc header.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00487">serializer.hpp:487</a></div></div>
<div class="ttc" id="aheap__serializer_8hpp_html"><div class="ttname"><a href="heap__serializer_8hpp.html">heap_serializer.hpp</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2transport_2struc_2shm_2error_8hpp_html"><div class="ttname"><a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_html_a0a2bd7de6f7becc91a76aae897d6821d"><div class="ttname"><a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a0a2bd7de6f7becc91a76aae897d6821d">TEMPLATE_SHM_BUILDER</a></div><div class="ttdeci">#define TEMPLATE_SHM_BUILDER</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00510">serializer.hpp:510</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_html_a6c1d27726471c6aa66a98b8b6b26331c"><div class="ttname"><a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#a6c1d27726471c6aa66a98b8b6b26331c">CLASS_SHM_BUILDER</a></div><div class="ttdeci">#define CLASS_SHM_BUILDER</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00513">serializer.hpp:513</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_html_aa1f45b4161ee9cad33108b8f94f981f5"><div class="ttname"><a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa1f45b4161ee9cad33108b8f94f981f5">TEMPLATE_SHM_READER</a></div><div class="ttdeci">#define TEMPLATE_SHM_READER</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00516">serializer.hpp:516</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_html_aa5a44fbd142148023f896d8a16898887"><div class="ttname"><a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp.html#aa5a44fbd142148023f896d8a16898887">CLASS_SHM_READER</a></div><div class="ttdeci">#define CLASS_SHM_READER</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00519">serializer.hpp:519</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1shm_html_af2acc444cc9664e57df8143b66b78d70"><div class="ttname"><a href="namespaceipc_1_1session_1_1shm.html#af2acc444cc9664e57df8143b66b78d70">ipc::session::shm::Arena_to_shm_session_t</a></div><div class="ttdeci">typename Arena_to_shm_session&lt; Arena &gt;::Type Arena_to_shm_session_t</div><div class="ttdoc">Alias that, given an Arena type (with Arena::construct&lt;T&gt;() which allocates/constructs a T),...</div><div class="ttdef"><b>Definition:</b> <a href="session_2shm_2shm_8hpp_source.html#l00054">shm.hpp:54</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1error_html_a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b">ipc::transport::struc::error::Code::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</a></div><div class="ttdeci">@ S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</div><div class="ttdoc">Structured message deserialization: Tried to deserialize without enough input segments (e....</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1error_html_a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406">ipc::transport::struc::error::Code::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</a></div><div class="ttdeci">@ S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</div><div class="ttdoc">Structured message deserialization: An input segment is not aligned as required.</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1classic_html_abfde278018c84aa1542475e9a4089c29"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">ipc::transport::struc::shm::classic::Builder</a></div><div class="ttdeci">Builder&lt; ipc::shm::classic::Pool_arena &gt; Builder</div><div class="ttdoc">Convenience alias: transport::struc::shm::Builder that works with boost.ipc.shm pools from ipc::shm::...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2classic_2classic__fwd_8hpp_source.html#l00036">classic_fwd.hpp:36</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1classic_html_af94f8698ca62a84d6366aaa931375d41"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">ipc::transport::struc::shm::classic::Reader</a></div><div class="ttdeci">Reader&lt; ipc::shm::classic::Pool_arena &gt; Reader</div><div class="ttdoc">Convenience alias: transport::struc::shm::Reader that works with boost.ipc.shm pools from ipc::shm::c...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2classic_2classic__fwd_8hpp_source.html#l00039">classic_fwd.hpp:39</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1error_html_a25a6db383af491442917e2dc8ff944a8a193ecb77fe093a4d59f5fafe68389624"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1error.html#a25a6db383af491442917e2dc8ff944a8a193ecb77fe093a4d59f5fafe68389624">ipc::transport::struc::shm::error::Code::S_DESERIALIZE_FAILED_SESSION_HOSED</a></div><div class="ttdeci">@ S_DESERIALIZE_FAILED_SESSION_HOSED</div><div class="ttdoc">Structured message deserialization: SHM-session borrow_object() indicated failure when interpreting a...</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1error_html_a25a6db383af491442917e2dc8ff944a8a80f5c2d8f8e819b23122a4fa1ea08500"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1error.html#a25a6db383af491442917e2dc8ff944a8a80f5c2d8f8e819b23122a4fa1ea08500">ipc::transport::struc::shm::error::Code::S_SERIALIZE_FAILED_SESSION_HOSED</a></div><div class="ttdeci">@ S_SERIALIZE_FAILED_SESSION_HOSED</div><div class="ttdoc">Structured message serialization: SHM-session lend_object() indicated failure when preparing an encod...</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_html"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm.html">ipc::transport::struc::shm</a></div><div class="ttdoc">Segregates zero-copy/SHM implementations of concepts residing in parent namespace ipc::transport::str...</div><div class="ttdef"><b>Definition:</b> <a href="capnp__msg__builder_8hpp_source.html#l00029">capnp_msg_builder.hpp:30</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_html_ac4969b49016844f884240b81ee1ab180"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm.html#ac4969b49016844f884240b81ee1ab180">ipc::transport::struc::shm::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Capnp_message_builder&lt; Shm_arena &gt; &amp;val)</div><div class="ttdoc">Prints string representation of the given Capnp_message_builder to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="capnp__msg__builder_8hpp_source.html#l00444">capnp_msg_builder.hpp:444</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_html_adb38fe88cfd5e758ef52c482d2902669"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm.html#adb38fe88cfd5e758ef52c482d2902669">ipc::transport::struc::shm::capnp_get_shm_handle_to_borrow</a></div><div class="ttdeci">void capnp_get_shm_handle_to_borrow(const schema::ShmHandle::Reader &amp;shm_handle_root, flow::util::Blob_sans_log_context *arg_to_borrow)</div><div class="ttdoc">Utility that's the reverse of capnp_set_lent_shm_handle() to be invoked on the deserializing side.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2util_8cpp_source.html#l00051">util.cpp:51</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html_a82a69eaa39cbe8a002de1266f1cbb5cb"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html#a82a69eaa39cbe8a002de1266f1cbb5cb">ipc::transport::struc::Segment_ptrs</a></div><div class="ttdeci">std::vector&lt; flow::util::Blob * &gt; Segment_ptrs</div><div class="ttdoc">Sequence of 1+ Blob pointers to blobs which must stay alive while these pointers may be dereferenced,...</div><div class="ttdef"><b>Definition:</b> <a href="struc__fwd_8hpp_source.html#l00122">struc_fwd.hpp:122</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html_ac70446757444f864afa21a5062bc5b0d"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html#ac70446757444f864afa21a5062bc5b0d">ipc::transport::struc::NULL_SESSION</a></div><div class="ttdeci">const Null_session NULL_SESSION</div><div class="ttdoc">The only necessary value of empty-type Null_session.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00035">heap_serializer.cpp:35</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae0be7edba7e30ffa3f8b742af621f2ab"><div class="ttname"><a href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">ipc::util::Blob_const</a></div><div class="ttdeci">boost::asio::const_buffer Blob_const</div><div class="ttdoc">Short-hand for an immutable blob somewhere in memory, stored as exactly a void const * and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00134">util_fwd.hpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_html_a4ccdeed058222c635745a4dc830e99f7"><div class="ttname"><a href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7">ipc::Log_component</a></div><div class="ttdeci">Log_component</div><div class="ttdoc">The flow::log::Component payload enumeration containing various log components used by Flow-IPC inter...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00322">common.hpp:323</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config_html"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html">ipc::transport::struc::shm::Builder::Config</a></div><div class="ttdoc">Implements Struct_builder::Config sub-concept.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00151">serializer.hpp:152</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config_html_a4c287783d239663193a681aad8690dd4"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#a4c287783d239663193a681aad8690dd4">ipc::transport::struc::shm::Builder::Config::m_logger_ptr</a></div><div class="ttdeci">flow::log::Logger * m_logger_ptr</div><div class="ttdoc">Logger to use for logging subsequently.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00165">serializer.hpp:165</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config_html_ab850e04c8a411941c75b74e7c6eccb36"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ab850e04c8a411941c75b74e7c6eccb36">ipc::transport::struc::shm::Builder::Config::m_top_builder_frame_prefix_sz</a></div><div class="ttdeci">size_t m_top_builder_frame_prefix_sz</div><div class="ttdoc">See struct doc header.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00168">serializer.hpp:168</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config_html_aca2f1b980653da86d533243f174107f3"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#aca2f1b980653da86d533243f174107f3">ipc::transport::struc::shm::Builder::Config::m_arena</a></div><div class="ttdeci">Arena * m_arena</div><div class="ttdoc">See struct doc header.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00174">serializer.hpp:174</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config_html_ae30cd8f4721bccd20ef5f195c332a960"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Builder_1_1Config.html#ae30cd8f4721bccd20ef5f195c332a960">ipc::transport::struc::shm::Builder::Config::m_top_builder_frame_postfix_sz</a></div><div class="ttdeci">size_t m_top_builder_frame_postfix_sz</div><div class="ttdoc">See struct doc header.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00171">serializer.hpp:171</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config_html"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">ipc::transport::struc::shm::Reader::Config</a></div><div class="ttdoc">Implements Struct_reader::Config sub-concept.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00380">serializer.hpp:381</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config_html_a3636cf0176e444342f4e178fbec94fa0"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#a3636cf0176e444342f4e178fbec94fa0">ipc::transport::struc::shm::Reader::Config::m_session</a></div><div class="ttdeci">Session m_session</div><div class="ttdoc">See shm::Reader class doc header for Shm_session discussion.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00397">serializer.hpp:397</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config_html_ad6bac9489c95df6c13a36d467ac1f6aa"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#ad6bac9489c95df6c13a36d467ac1f6aa">ipc::transport::struc::shm::Reader::Config::m_logger_ptr</a></div><div class="ttdeci">flow::log::Logger * m_logger_ptr</div><div class="ttdoc">Logger to use for logging subsequently.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00391">serializer.hpp:391</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
